org.eclipse.vtp.framework.interactions.core.support
Class AbstractPlatform

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.support.AbstractPlatform

All Implemented Interfaces:

IPlatform

Direct Known Subclasses:

VoicePlatform

public abstract class AbstractPlatform
extends java.lang.Object
implements IPlatform

A base implementation of IPlatform.

Author:

Lonnie Pryor

Constructor Summary

protected

AbstractPlatform() Creates a new AbstractPlatform.

Method Summary

IDocument	createDocument(ILinkFactory links, IRenderingQueue renderingQueue)
protected IDocument	renderBridgeMessage(ILinkFactory links, BridgeMessageCommand bridgeMessageCommand) Renders a bridge message to the user.
protected IDocument	renderDataRequest(ILinkFactory links, DataRequestCommand dataRequestCommand) Renders a data request to the user.
protected IDocument	renderEndMessage(ILinkFactory links, EndMessageCommand endMessageCommand) Renders an end message to the user.
protected IDocument	renderExternalReference(ILinkFactory links, ExternalReferenceCommand externalReferenceCommand) Renders an external reference to the user.
protected IDocument	renderFinalDocument(ILinkFactory links, FinalCommand finalCommand) Renders the final document to the user.
protected IDocument	renderInitialDocument(ILinkFactory links, InitialCommand initialCommand) Renders the initial document to the user.
protected IDocument	renderInputRequest(ILinkFactory links, InputRequestCommand inputRequestCommand) Renders an input request to the user.
protected IDocument	renderMetaDataMessage(ILinkFactory links, MetaDataMessageCommand metaDataMessageCommand) Renders a meta-data message to the user.
protected IDocument	renderMetaDataRequest(ILinkFactory links, MetaDataRequestCommand metaDataMessageRequest) Renders a meta-data request to the user.
protected IDocument	renderOutputMessage(ILinkFactory links, OutputMessageCommand outputMessageCommand) Renders an output message to the user.
protected IDocument	renderSelectionRequest(ILinkFactory links, SelectionRequestCommand selectionRequestCommand) Renders a selection request to the user.
protected IDocument	renderTransferMessage(ILinkFactory links, TransferMessageCommand transferMessageCommand) Renders a transfer message to the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.vtp.framework.interactions.core.platforms.IPlatform

getInteractionTypeID

Constructor Detail

AbstractPlatform

protected AbstractPlatform()

Creates a new AbstractPlatform.

Method Detail

renderInitialDocument

protected IDocument renderInitialDocument(ILinkFactory links,
                                          InitialCommand initialCommand)

Renders the initial document to the user.

Parameters:

links - The link factory to use.

initialCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderOutputMessage

protected IDocument renderOutputMessage(ILinkFactory links,
                                        OutputMessageCommand outputMessageCommand)

Renders an output message to the user.

Parameters:

links - The link factory to use.

outputMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderMetaDataMessage

protected IDocument renderMetaDataMessage(ILinkFactory links,
                                          MetaDataMessageCommand metaDataMessageCommand)

Renders a meta-data message to the user.

Parameters:

links - The link factory to use.

metaDataMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderMetaDataRequest

protected IDocument renderMetaDataRequest(ILinkFactory links,
                                          MetaDataRequestCommand metaDataMessageRequest)

Renders a meta-data request to the user.

Parameters:

links - The link factory to use.

metaDataMessageRequest - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderInputRequest

protected IDocument renderInputRequest(ILinkFactory links,
                                       InputRequestCommand inputRequestCommand)

Renders an input request to the user.

Parameters:

links - The link factory to use.

inputRequestCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderSelectionRequest

protected IDocument renderSelectionRequest(ILinkFactory links,
                                           SelectionRequestCommand selectionRequestCommand)

Renders a selection request to the user.

Parameters:

links - The link factory to use.

selectionRequestCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderDataRequest

protected IDocument renderDataRequest(ILinkFactory links,
                                      DataRequestCommand dataRequestCommand)

Renders a data request to the user.

Parameters:

links - The link factory to use.

dataRequestCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderExternalReference

protected IDocument renderExternalReference(ILinkFactory links,
                                            ExternalReferenceCommand externalReferenceCommand)

Renders an external reference to the user.

Parameters:

links - The link factory to use.

externalReferenceCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderTransferMessage

protected IDocument renderTransferMessage(ILinkFactory links,
                                          TransferMessageCommand transferMessageCommand)

Renders a transfer message to the user.

Parameters:

links - The link factory to use.

transferMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderBridgeMessage

protected IDocument renderBridgeMessage(ILinkFactory links,
                                        BridgeMessageCommand bridgeMessageCommand)

Renders a bridge message to the user.

Parameters:

links - The link factory to use.

bridgeMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderEndMessage

protected IDocument renderEndMessage(ILinkFactory links,
                                     EndMessageCommand endMessageCommand)

Renders an end message to the user.

Parameters:

links - The link factory to use.

endMessageCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

renderFinalDocument

protected IDocument renderFinalDocument(ILinkFactory links,
                                        FinalCommand finalCommand)

Renders the final document to the user.

Parameters:

links - The link factory to use.

finalCommand - The command to render.

Returns:

The document that was rendered from the command or null if no document could be rendered.

createDocument

public IDocument createDocument(ILinkFactory links,
                                IRenderingQueue renderingQueue)

Specified by:

createDocument in interface IPlatform